vcSinglePositionTargetContainer

A container for a one .

See in: Overview

Module: vcRobotics2

Parent: -

Children -

Referenced by: vcJointMotionStatement.TargetContainer, vcLinearMotionStatement.TargetContainer, vcPtpMotionStatement.TargetContainer

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
OwnedTargetvcPositionTargetRGets the target owned by this container, or None.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
createTargetvcPositionTargetvcPositionTargetType type,
Optional Keyword[name = String]
Creates a new target into this container.
See more
Parameters:
type (str): Type name of the statement.
Optional: name (str): Name for the new target. If omitted, a name will be automatically generated.

Returns:
vcPositionTarget: The new target.

Exceptions:
ValueError: When the target name is reserved or when the type name is empty or not supported.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnTargetAddedvcPositionTarget positionInvoked when a new target position is added to the object.

Parameters:
target position (vcPositionTarget): The newly added target position.
OnTargetRemovingvcPositionTarget positionInvoked when a target position is about to be removed from the object.
See more
Parameters:
target position (vcPositionTarget): The target position about to be removed.